home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1992 June: ROMin Holiday / ADC Developer CD (1992-06) (''ROMin Holiday'')_iso / Developer Connection - 06-1992.iso / Development Platforms / Apple II / Essentials / APW.ORCA.Cmds / Gregs.APW.Utils / Documentation / Backup next >
Encoding:
Text File  |  1990-07-19  |  6.7 KB  |  140 lines  |  [TEXT/pdos]
  1. Backup -- Directory File Backup
  2.  
  3. Syntax      Backup [option...] -from 'directory' -to 'directory'
  4.  
  5. Description Files in a source ("from") directory are copied to a destination
  6.             ("to") directory based on the modification date.  By default, only
  7.             files that already exist in both the source and destination
  8.             directories are candidates for copying.  (The -a option can
  9.             override this default.)  Backup does not actually make the copies.
  10.             Instead, it generates a script of APW Shell Duplicate commands.
  11.             (The -doit option can override this default.)
  12.  
  13.             Backup-s default operation is based on the premise that you already
  14.             have an existing directory on two sets of disks (generally a hard
  15.             disk and a set of 3.5-inch disks) and that you want to make sure
  16.             that the files on one of the disks are the same as the files on the
  17.             other disk.  Thus, it is the files on the destination ("to") disk
  18.             that determine which files can be copied from the source ("from")
  19.             disk.
  20.  
  21.             A shell Duplicate command is generated to the standard output file
  22.             if
  23.             o   a file on a source disk also exists on the destination disk,
  24.                 and
  25.             o   the modification date of the source is newer than that of the
  26.                 destination.
  27.  
  28.             In addition to the basic function of generating shell duplicate
  29.             commands, Backup also provides these services:
  30.  
  31.             o   Directories can be recursively processed, allowing processing
  32.                 of all directories and subdirectories contained with
  33.                 directories (-f).
  34.             o   (More to come in the future, hopefully...)
  35.  
  36. Input       None.
  37.  
  38. Output      For each file to be copied, a shell Duplicate command is generated
  39.             to the standard output file as follows:
  40.  
  41.             Duplicate FromFile ToFile
  42.  
  43.             If you are using the -e option, then the shell's Eject commands are
  44.             generated at the end of the list of Duplicates.  These commands
  45.             cause the source and/or destination disks to eject if the -from and
  46.             -to options specify as parameters either or boths disks as
  47.             removeable media (i.e. contained in a floppy disk drive).
  48.  
  49. Diagnostics Errors and warnings are written to the diagnostic output file.  If
  50.             you specify the -p option, progress information is written to
  51.             diagnostic output also.
  52.  
  53. Status      Backup may return the following status codes:
  54.  
  55.             0   No errors; Duplicate commands have been generated
  56.             1   Parameter or option error
  57.             2   System error
  58.             3   No errors and no files to duplicate
  59.  
  60.             Note:  Backup returns a status code of 3 when no files need
  61.             copying.  If no files are copied because NONE of the files in the
  62.             source directory exists in the destination directory, Backup also
  63.             reports a warning ot the diagnostic output file.  If there are no
  64.             name matches, it is possible that your from/to pathnames were
  65.             specified incorrectly.  Hence, Backup lets you know of the possible
  66.             error.  Backup does not report this as an error if you use the -a
  67.             option.
  68.  
  69. Options     -a  Normally, a file in the source ("from") is ignored if it does
  70.                 not exist in the destination ("to").  Using the -a option
  71.                 forces Backup to generate a shell Duplicate command for all
  72.                 files in the source that don't exist in the destination.
  73.  
  74.             -c  Create directories.  When a directory name doesn't exist in the
  75.                 destination disk and there are files in the source to copy, -c
  76.                 generates a shell Create command to create the directory on the
  77.                 destination disk.  Note that this option makes sense only if
  78.                 you are using the -a option.
  79.  
  80.             -doit
  81.                 When this option is specified, Backup will send a command
  82.                 string to the APW shell for direct execution instead of writing
  83.                 the command string to standard output.
  84.  
  85.             -e  Eject the disk(s) from the drive if the disk is removeable.
  86.                 Disks are ejected when Backup terminates if there are no files
  87.                 to duplicate.  If Duplicate commands are generated, then shell
  88.                 Eject commands are generated to eject the specified disk(s).
  89.  
  90.             -from directory
  91.                 Specify the directory from which to get the source list of
  92.                 files.  If this option is omitted, the list will be built from
  93.                 the current directory.  This directory may be specified as
  94.                 either a GS/OS pathname or device name.
  95.  
  96.             -lastcmd 'cmd'
  97.                 Generate the specified command as the last command.  For
  98.                 example, a Beep command could be generated to signal that all
  99.                 the duplicates have been completed.
  100.  
  101.             -p  Write Backup's version number and progress information to
  102.                 diagnostic output.
  103.  
  104.             -r  Recursively process subdirectories encountered.
  105.  
  106.             -t 'type'
  107.                 Consider only files of the specified 'type' as candidates for
  108.                 backup.  'type' may be specified as a decimal or hexadecimal
  109.                 (preceeded by '$') number, or as a 3 character mnemonic.
  110.                 Backup recognizes the following mnemonics:
  111.  
  112.                 TXT - text files
  113.                 BIN - binary files
  114.                 SRC - APW source files
  115.                 OBJ - APW object files
  116.                 LIB - APW library files
  117.                 S16 - GS/OS applications
  118.                 RTL - Run Time Library files
  119.                 EXE - APW shell utilities
  120.                 PIF - Permanent initialization files
  121.                 TIF - Temporary initialization files
  122.                 NDA - New desk accessory files
  123.                 CDA - Classic desk accessory files
  124.                 TOL - Apple IIGS Tool files
  125.                 SYS - ProDOS 8 applications
  126.  
  127.             -to 'directory'
  128.                 Specify the directory from which to get the destination list of
  129.                 files.  If the -to option is omitted and the -from option was
  130.                 specified, the destination will default to the current
  131.                 directory.  You MUST specify the -to if -from is omitted.
  132.  
  133. Examples
  134.             Backup -from .AppleDisk3.5A -to */APW -r
  135.  
  136.             Recursively compares files and directories on your first 3.5" drive
  137.             to the corresponding files and directories in the APW directory of
  138.             your boot drive.  This is a very easy way to update your APW system
  139.             when an update is received.
  140.